Azure Maps Tileset Service (preview:2022-09-01)

2025/10/06 • 7 deleted methods

Tileset_Create (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The Tileset Create request creates a tileset from the specified dataset. A tileset contains a set of tiles that can be consumed from the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the [DataSet Create API](/rest/api/maps/v2/dataset/create). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. ## Submit Create Request To create your tileset you will make a `POST` request with an **optional request body** as [tileset configuration](/rest/api/maps-creator/tileset/create#tilesetconfiguration). The `datasetId` query parameter will be used as the source of the tileset data. The Create Tileset API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).
Reference :  Link ¶

⚼ Request

POST:  /tilesets
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
datasetId:
{
Description: The unique `datasetId` that the tileset create API uses to retrieve features to generate tiles. The `datasetId` must have been obtained from a successful [Dataset Create API](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create) call. ,
Required: True ,
}
string ,
description:
{
Description: User provided description of the tileset. Maximum length 1024 characters. ,
Required: False ,
}
string ,
TilesetConfiguration:
{
Description: The custom tileset configuration to use. ,
Required: False ,
}
{
version:
{
Description: The version of Azure Maps Tiling service configuration reference that the tileset configuration uses. Currently only version 1 is allowed. Using any version other the current version or a previous version will result in an error. ,
Format: int32 ,
Required: True ,
}
integer ,
layers:
{
Description: The names of the layers and their configuration options. The configuration layers object contains key-value pairs associating the names of tile layers with their configuration. For each key-value pair, the key is the name of the layer, and the value is a LayerObject containing the configuration and options for the layer. Each layer must have a name. This is the unique identifier for the layer of data in your final tileset. In any tileset, each layer name must be unique. The layer name must be a string with only underscores (_) and alphanumeric characters. The corresponding LayerObject for each layer name describes how that vector tile layer should be created. It specifies which feature classes to retrieve feature data, the precision of the data through zoom levels, and how to transform features and render them into tiles. ,
Required: True ,
}
object ,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: New URL to check for the results of the long-running operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tileset_List (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The Tileset List request allows the caller to fetch a list of all tilesets created. Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
Reference :  Link ¶

⚼ Request

GET:  /tilesets
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tilesets:
{
Description: A list of all tilesets. ,
Required: False ,
}
[
{
tilesetId:
{
Description: The unique tileset id for the tileset. ,
Required: False ,
}
string ,
ontology:
{
Description: The ontology version of this dataset. ,
Required: False ,
}
string ,
datasetId:
{
Description: The unique dataset Id used to create the tileset. ,
Required: False ,
}
string ,
description:
{
Description: The description the caller provided when creating the tileset. Maximum length 1024 characters. ,
Required: False ,
}
string ,
minZoom:
{
Description: The lowest tile zoom level tile generated for the tileset. ,
Format: int32 ,
Required: False ,
}
integer ,
maxZoom:
{
Description: The highest tile zoom level tile generated for the tileset. ,
Format: int32 ,
Required: False ,
}
integer ,
bbox:
{
Description: Bounding box which all features of the tileset lay within. Projection used - EPSG:3857. Format : 'minLon, minLat, maxLon, maxLat'. ,
Required: False ,
}
[
number ,
]
,
tilesetConfiguration:
{
Description: Tileset configuration which is used to build the tileset. ,
Required: False ,
}
{
version:
{
Description: The version of Azure Maps Tiling service configuration reference that the tileset configuration uses. Currently only version 1 is allowed. Using any version other the current version or a previous version will result in an error. ,
Format: int32 ,
Required: True ,
}
integer ,
layers:
{
Description: The names of the layers and their configuration options. The configuration layers object contains key-value pairs associating the names of tile layers with their configuration. For each key-value pair, the key is the name of the layer, and the value is a LayerObject containing the configuration and options for the layer. Each layer must have a name. This is the unique identifier for the layer of data in your final tileset. In any tileset, each layer name must be unique. The layer name must be a string with only underscores (_) and alphanumeric characters. The corresponding LayerObject for each layer name describes how that vector tile layer should be created. It specifies which feature classes to retrieve feature data, the precision of the data through zoom levels, and how to transform features and render them into tiles. ,
Required: True ,
}
object ,
}
,
defaultMapConfigurationId:
{
Description: The default generated map configuration id for the tileset ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: If present, the location of the next page of data. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tileset_Get (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The Tileset Get request allows the caller to fetch a tileset. Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
Reference :  Link ¶

⚼ Request

GET:  /tilesets/{tilesetId}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
tilesetId:
{
Description: The Tileset Id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tilesetId:
{
Description: The unique tileset id for the tileset. ,
Required: False ,
}
string ,
ontology:
{
Description: The ontology version of this dataset. ,
Required: False ,
}
string ,
datasetId:
{
Description: The unique dataset Id used to create the tileset. ,
Required: False ,
}
string ,
description:
{
Description: The description the caller provided when creating the tileset. Maximum length 1024 characters. ,
Required: False ,
}
string ,
minZoom:
{
Description: The lowest tile zoom level tile generated for the tileset. ,
Format: int32 ,
Required: False ,
}
integer ,
maxZoom:
{
Description: The highest tile zoom level tile generated for the tileset. ,
Format: int32 ,
Required: False ,
}
integer ,
bbox:
{
Description: Bounding box which all features of the tileset lay within. Projection used - EPSG:3857. Format : 'minLon, minLat, maxLon, maxLat'. ,
Required: False ,
}
[
number ,
]
,
tilesetConfiguration:
{
Description: Tileset configuration which is used to build the tileset. ,
Required: False ,
}
{
version:
{
Description: The version of Azure Maps Tiling service configuration reference that the tileset configuration uses. Currently only version 1 is allowed. Using any version other the current version or a previous version will result in an error. ,
Format: int32 ,
Required: True ,
}
integer ,
layers:
{
Description: The names of the layers and their configuration options. The configuration layers object contains key-value pairs associating the names of tile layers with their configuration. For each key-value pair, the key is the name of the layer, and the value is a LayerObject containing the configuration and options for the layer. Each layer must have a name. This is the unique identifier for the layer of data in your final tileset. In any tileset, each layer name must be unique. The layer name must be a string with only underscores (_) and alphanumeric characters. The corresponding LayerObject for each layer name describes how that vector tile layer should be created. It specifies which feature classes to retrieve feature data, the precision of the data through zoom levels, and how to transform features and render them into tiles. ,
Required: True ,
}
object ,
}
,
defaultMapConfigurationId:
{
Description: The default generated map configuration id for the tileset ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tileset_Delete (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The Tileset Delete request allows the caller to delete a created tileset. You can use this API if a tileset is no longer needed. Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. ### Submit Delete Request To delete your content you will issue a `DELETE` request where the path will contain the `tilesetId` of the tileset to delete.
#### Delete request "Successful" The Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
#### Delete request "Failed" A HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. Here is a sample error response:
```json { "error": { "code": "400 BadRequest", "message": "Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist." } } ```
Reference :  Link ¶

⚼ Request

DELETE:  /tilesets/{tilesetId}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
tilesetId:
{
Description: The Tileset Id ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tileset_GetConfiguration (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The Tileset Get Configuration request allows the caller to get a default [tileset configuration](/rest/api/maps-creator/tileset/get-configuration#tilesetconfiguration) based on the dataset provided. Then the tileset configuration can be used to create custom tileset using the [Tileset Create API](/rest/api/documentation-preview/tileset/create). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
Reference :  Link ¶

⚼ Request

GET:  /tilesets:fetchConfiguration
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
datasetId:
{
Description: The unique `datasetId` that the tileset create API uses to retrieve features to generate tiles. The `datasetId` must have been obtained from a successful [Dataset Create API](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create) call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
version:
{
Description: The version of Azure Maps Tiling service configuration reference that the tileset configuration uses. Currently only version 1 is allowed. Using any version other the current version or a previous version will result in an error. ,
Format: int32 ,
Required: True ,
}
integer ,
layers:
{
Description: The names of the layers and their configuration options. The configuration layers object contains key-value pairs associating the names of tile layers with their configuration. For each key-value pair, the key is the name of the layer, and the value is a LayerObject containing the configuration and options for the layer. Each layer must have a name. This is the unique identifier for the layer of data in your final tileset. In any tileset, each layer name must be unique. The layer name must be a string with only underscores (_) and alphanumeric characters. The corresponding LayerObject for each layer name describes how that vector tile layer should be created. It specifies which feature classes to retrieve feature data, the precision of the data through zoom levels, and how to transform features and render them into tiles. ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tileset_ValidateConfiguration (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The Tileset Validate Configuration request allows the caller to validate a [tileset configuration](/rest/api/maps-creator/tileset/validate-configuration#tilesetconfiguration). Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
Reference :  Link ¶

⚼ Request

POST:  /tilesets:validateConfiguration
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
datasetId:
{
Description: The unique `datasetId` that the tileset create API uses to retrieve features to generate tiles. The `datasetId` must have been obtained from a successful [Dataset Create API](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create) call. ,
Required: True ,
}
string ,
TilesetConfiguration:
{
Description: The custom tileset configuration to use. ,
Required: False ,
}
{
version:
{
Description: The version of Azure Maps Tiling service configuration reference that the tileset configuration uses. Currently only version 1 is allowed. Using any version other the current version or a previous version will result in an error. ,
Format: int32 ,
Required: True ,
}
integer ,
layers:
{
Description: The names of the layers and their configuration options. The configuration layers object contains key-value pairs associating the names of tile layers with their configuration. For each key-value pair, the key is the name of the layer, and the value is a LayerObject containing the configuration and options for the layer. Each layer must have a name. This is the unique identifier for the layer of data in your final tileset. In any tileset, each layer name must be unique. The layer name must be a string with only underscores (_) and alphanumeric characters. The corresponding LayerObject for each layer name describes how that vector tile layer should be created. It specifies which feature classes to retrieve feature data, the precision of the data through zoom levels, and how to transform features and render them into tiles. ,
Required: True ,
}
object ,
}
,
}

⚐ Response (200)

{
valid:
{
Description: Validation result. ,
Required: False ,
}
boolean ,
warnings:
{
Description: The list of validation warnings. ,
Required: False ,
}
[
{
code:
{
Description: Validation warning code. ,
Required: False ,
}
string ,
message:
{
Description: Validation warning message. ,
Required: False ,
}
string ,
target:
{
Description: The target element for the validation warning. ,
Required: False ,
}
string ,
}
,
]
,
errors:
{
Description: The list of validation errors. ,
Required: False ,
}
[
{
code:
{
Description: Validation error code. ,
Enum:
{
DuplicateLayerNameFound: The layer name should be unique. ,
UndefinedFeatureClasses: Feature class should be defined in ontology definition, and the feature class name is case sensitive. ,
DuplicateFeatureClassFound: Feature class name should be unique. ,
CustomLayerNameNotSupported: Custom layer name is not supported right now. ,
CustomOntologyNotSupported: Custom ontology is not supported right now, 'Facility-2.0' is the supported ontology. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation error message. ,
Required: False ,
}
string ,
target:
{
Description: The target element for the validation error. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tileset_GetOperation (removed)
Description :  This path will be obtained from a call to /tilesets/create. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once successfully completed.
Reference :  Link ¶

⚼ Request

GET:  /tilesets/operations/{operationId}
{
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID to query the status for the tileset create/import request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
resource-location:
{
Description: If successful, a URI where details on the newly created resource can be found. ,
}
string ,
}
,
$schema:
{
Description: The response model for a Long-Running Operations API. ,
}
{
operationId:
{
Description: The Id for this long-running operation. ,
Required: False ,
}
string ,
status:
{
Description: The status state of the request. ,
Enum:
{
NotStarted: The request has not started processing yet. ,
Running: The request has started processing. ,
Failed: The request has one or more failures. ,
Succeeded: The request has successfully completed. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The created timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
warning:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}